home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilSaturateImg.z / ilSaturateImg
Encoding:
Text File  |  2002-10-03  |  10.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg - performs color saturation of an image
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg : ilMonadicImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This operator performs a color saturation operation on the input image.
  19.      The degree of saturation is controlled by a parameter whose value ranges
  20.      from zero to an arbitarily large number.  A value of zero will completely
  21.      desaturate the image (the same as ilGrayImg), while a value of one will
  22.      not change the input image at all.  The larger the value above one, the
  23.      more saturated the resulting image will be.  Negative saturation values
  24.      produce inverse-colored images in which the luminance is preserved.
  25.  
  26. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  27.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  28.  
  29.           ilSaturateImg *ilSaturateImgCreate(ilImage *img, float saturation)
  30.  
  31.  
  32.      CCCChhhhaaaannnnggggiiiinnnngggg ssssaaaattttuuuurrrraaaattttiiiioooonnnn
  33.  
  34.           float ilSaturateImgGetSaturation(ilImage* img)
  35.           void ilSaturateImgSetSaturation(ilImage* img, float saturation)
  36.  
  37.  
  38. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  39.      iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg(((())))
  40.  
  41.           ilSaturateImg *ilSaturateImgCreate(ilImage *img, float saturation)
  42.  
  43.  
  44.           This is the constructor for this class.  The input image is given by
  45.           _i_m_g.  The initial degree of saturation is given by _s_a_t_u_r_a_t_i_o_n.
  46.  
  47.      ggggeeeettttSSSSaaaattttuuuurrrraaaattttiiiioooonnnn(((())))
  48.  
  49.           float ilSaturateImgGetSaturation(ilImage* img)
  50.  
  51.  
  52.           This function returns the current value of the saturation parameter.
  53.  
  54.      sssseeeettttSSSSaaaattttuuuurrrraaaattttiiiioooonnnn(((())))
  55.  
  56.           void ilSaturateImgSetSaturation(ilImage* img, float saturation)
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.           The function sets the value of the saturation parameter.
  75.  
  76. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  77.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMoooonnnnaaaaddddiiiiccccIIIImmmmgggg
  78.      ilMondadicImgGetOffset(), ilMondadicImgSetOffset()
  79.  
  80.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  81.      ilOpImgClearClamp(), ilOpImgGetBias(), ilOpImgGetClamp(),
  82.      ilOpImgGetValidOrders(), ilOpImgGetValidTypes(), ilOpImgIsClamped(),
  83.      ilOpImgIsPrecisionKept(), ilOpImgKeepPrecision(), ilOpImgSetBias(),
  84.      ilOpImgSetClampMinMax(), ilOpImgSetClamp()
  85.  
  86.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  87.      ilMemCacheImgEnableMP(), ilMemCacheImgGetPageTime(),
  88.      ilMemCacheImgGetRetainMode(), ilMemCacheImgGetThrashMode(),
  89.      ilMemCacheImgGetThrashTime(), ilMemCacheImgGetTotalPageTime(),
  90.      ilMemCacheImgIsMPenabled(), ilMemCacheImgSetRetainMode(),
  91.      ilMemCacheImgSetThrashMode()
  92.  
  93.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  94.      ilCacheImgFlush(), ilCacheImgGetCacheSize()
  95.  
  96.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  97.      ilAddInput(), ilAllocFillData(), ilClipTile(), ilClipTileAsTile(),
  98.      ilClipTileFloat(), ilClipTileFloatAsTile(),
  99.      ilConfigureRetainedCacheImage(), ilCopy(), ilCopyTile(), ilCopyTile3D(),
  100.      ilCopyTileCfg(), ilFillTile(), ilFillTile3D(), ilFillTileRGB(),
  101.      ilFreeFillData(), ilGetColorImg(), ilGetColorModel(), ilGetColormap(),
  102.      ilGetColormapPtr(), ilGetCompression(), ilGetConfig(), ilGetCsize(),
  103.      ilGetDataType(), ilGetDimensions(), ilGetDirectInput(),
  104.      ilGetDisplayCacheEnable(), ilGetFill(), ilGetFillData(),
  105.      ilGetFillValue(), ilGetHeight(), ilGetHwEnable(), ilGetHwHint(),
  106.      ilGetHwHintName(), ilGetHwIntHint(), ilGetHwIntHintName(), ilGetInput(),
  107.      ilGetInputTileRequirement(), ilGetLockTileSet(), ilGetMappedPageSize(),
  108.      ilGetMappedSize(), ilGetMaxColormapLevels(), ilGetMaxValue(),
  109.      ilGetMinValue(), ilGetNumChans(), ilGetNumInputs(), ilGetOrder(),
  110.      ilGetOrientation(), ilGetPageBorder(), ilGetPageBorderPtr(),
  111.      ilGetPageBorderX(), ilGetPageBorderY(), ilGetPageBorderZ(),
  112.      ilGetPageCounts(), ilGetPageDelta(), ilGetPageDeltaStruct(),
  113.      ilGetPageDimensions(), ilGetPageIndices(), ilGetPageOrigin(),
  114.      ilGetPageOriginC(), ilGetPageOriginStruct(), ilGetPageOriginX(),
  115.      ilGetPageOriginY(), ilGetPageOriginZ(), ilGetPageSize(),
  116.      ilGetPageSizeBytes(), ilGetPageSizeC(), ilGetPageSizePix(),
  117.      ilGetPageSizeStruct(), ilGetPageSizeVal(), ilGetPageSizeX(),
  118.      ilGetPageSizeXY(), ilGetPageSizeY(), ilGetPageSizeZ(), ilGetPixel(),
  119.      ilGetPixel3D(), ilGetPriority(), ilGetScaleMax(), ilGetScaleMin(),
  120.      ilGetSize(), ilGetSizePtr(), ilGetStrides(), ilGetSubTile(),
  121.      ilGetSubTile3D(), ilGetTile(), ilGetTile3D(), ilGetWidth(), ilGetXsize(),
  122.      ilGetYsize(), ilGetZsize(), ilHasPageBorder(), ilHasPages(),
  123.      ilInitScaleMinMax(), ilIsColorImg(), ilIsIntegral(),
  124.      ilIsMirrorOrientation(), ilIsSigned(), ilIsWritable(), ilLockPage(),
  125.      ilLockPageSet(), ilLockTile(), ilLockTile3D(), ilMapFlipTrans(),
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllSSSSaaaattttuuuurrrraaaatttteeeeIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.      ilMapFromInput(), ilMapFromInput2D(), ilMapFromInput3D(),
  141.      ilMapFromSource(), ilMapFromSource2D(), ilMapFromSource3D(),
  142.      ilMapOrientation(), ilMapSize(), ilMapTile(), ilMapTileFlipTrans(),
  143.      ilMapTileFloat(), ilMapToInput(), ilMapToInput2D(), ilMapToInput3D(),
  144.      ilMapToSource(), ilMapToSource2D(), ilMapToSource3D(), ilMapXY(),
  145.      ilMapXYFloat(), ilMapXYSign(), ilQCopyTileCfg(), ilQFillTile3D(),
  146.      ilQFillTileRGB(), ilQGetSubTile3D(), ilQGetTile3D(), ilQLockPageSet(),
  147.      ilQSetSubTile3D(), ilQSetTile3D(), ilRemoveHwHint(),
  148.      ilRemoveHwHintName(), ilRemoveInput(), ilSetColorModel(),
  149.      ilSetColormap(), ilSetCompression(), ilSetCsize(), ilSetDataType(),
  150.      ilSetDisplayCacheEnable(), ilSetFill(), ilSetFillValue(),
  151.      ilSetHwEnable(), ilSetHwHint(), ilSetHwIntHint(), ilSetHwIntHintName(),
  152.      ilSetInput(), ilSetMaxColormapLevels(), ilSetMaxValue(), ilSetMinValue(),
  153.      ilSetNumChans(), ilSetOrder(), ilSetOrientation(), ilSetPageBorder(),
  154.      ilSetPageBorderStruct(), ilSetPageSize(), ilSetPageSizeC(),
  155.      ilSetPageSizeStruct(), ilSetPageSizeXY(), ilSetPageSizeZ(), ilSetPixel(),
  156.      ilSetPixel3D(), ilSetPriority(), ilSetScaleMinMax(), ilSetScaleType(),
  157.      ilSetSize(), ilSetSubTile(), ilSetSubTile3D(), ilSetTile(),
  158.      ilSetTile3D(), ilSetXYsize(), ilSetXsize(), ilSetYsize(), ilSetZsize(),
  159.      ilUnlockPage(), ilUnlockPageSet()
  160.  
  161.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  162.      ilLinkClearSet(), ilLinkClearStatus(), ilLinkGetDescription(),
  163.      ilLinkGetDirectParent(), ilLinkGetDisabledIndex(), ilLinkGetFloatProp(),
  164.      ilLinkGetGenerationID(), ilLinkGetIntProp(), ilLinkGetNumChildren(),
  165.      ilLinkGetNumParents(), ilLinkGetParent(), ilLinkGetPtrProp(),
  166.      ilLinkGetRelatedChild(), ilLinkGetRelatedDelete(),
  167.      ilLinkGetRelatedType(), ilLinkGetStatus(), ilLinkIsAllowed(),
  168.      ilLinkIsAltered(), ilLinkIsEnabled(), ilLinkIsRelated(), ilLinkIsSet(),
  169.      ilLinkRemoveParent(), ilLinkRemoveProp(), ilLinkSetDescription(),
  170.      ilLinkSetDisabledIndex(), ilLinkSetEnabled(), ilLinkSetParent(),
  171.      ilLinkSetProp(), ilLinkSetRelatedDelete(), ilLinkSetRelatedType()
  172.  
  173. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  174.      ilCache, lImage, ilMonadicImg, ilOpImg
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.